Summary

Includes a document in the current document. Be aware that the document you choose should NOT contain metadata.

This component has long been one of the most important components in Content Studio. In CS 5, however, it is often a better idea to use an User Control (.ascx - file) as an included document instead. The User Control is the standard ASP.NET component to use as an included document. User Controls also offer better performance and you create them just like any other Content Studio document without meta data.
Even though it is possible to include an User Control with this component this is not optional mostly for performance reasons. Also, some of the features that are available in the User Control is not available if it included by using Insert document. Thus, make sure that User Controls are included directly on the hosting page instead of by this control.

Component properties
Category AS Document
Version 1.0
Complies with Xhtml 1.0 / 1.1 rules Yes
Supported server programming languages C# Visual Basic.NET
Output content type Unspecified or not applicable

When to use

This component is typically used when there is a need to include a document without meta data in another document. Nowadays the usage of this component can often be replaced by an User Control.

Programming interface

Parameters

ID
The identifier of the document you want to include
PTID
Optional, the identifier of a presentation template that is used to process the included document. Only applicable if the document to include is an EPT document.
Run in PreInit
The execution of the document you choose to include will run in the PreInit event of the current document. This feature will enable adding and updating server controls in the parent-document of the included document.
Use silent mode
Indicates whether or not the included document runs in silent mode i.e. all errors thrown by Content Studio (not runtime errors) will be hidden from the visitor.
Cache methods
  • No cache - Do not cache the included document.
  • Use application cache. - Cache the included document using application cache.
Application cache timeout
Indicates how long time, in minutes, cached data in the application cache should be valid. When this time has expired the cache will automatically be renewed. Zero (0) indicates that the cache should be valid indefinite or until the Web site is restarted. 

Remarks

The document you include should NOT contain metadata.